🎖️GitЯра🎖️
Node / meshtastic / Meshtastic-Android / files / core / proto / src / main / wire-includes / google / protobuf / descriptor.proto
Displaying Raw • Download
core/proto/src/main/wire-includes/google/protobuf/descriptor.proto 0e068053bce224de4871cc3d8cc05a9719ad88db (0e068053) Text, 38.50 KB
T8b949e// Protocol Buffers - Google's data interchange format
T8b949e// Copyright 2008 Google Inc. All rights reserved.
T8b949e// https://developers.google.com/protocol-buffers/
T8b949e//
T8b949e// Redistribution and use in source and binary forms, with or without
T8b949e// modification, are permitted provided that the following conditions are
T8b949e// met:
T8b949e//
T8b949e// * Redistributions of source code must retain the above copyright
T8b949e// notice, this list of conditions and the following disclaimer.
T8b949e// * Redistributions in binary form must reproduce the above
T8b949e// copyright notice, this list of conditions and the following disclaimer
T8b949e// in the documentation and/or other materials provided with the
T8b949e// distribution.
T8b949e// * Neither the name of Google Inc. nor the names of its
T8b949e// contributors may be used to endorse or promote products derived from
T8b949e// this software without specific prior written permission.
T8b949e//
T8b949e// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
T8b949e// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
T8b949e// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
T8b949e// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
T8b949e// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
T8b949e// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
T8b949e// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
T8b949e// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
T8b949e// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
T8b949e// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
T8b949e// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
T8b949e// Author: kenton@google.com (Kenton Varda)
T8b949e// Based on original Protocol Buffers design by
T8b949e// Sanjay Ghemawat, Jeff Dean, and others.
T8b949e//
T8b949e// The messages in this file describe the definitions found in .proto files.
T8b949e// A valid .proto file can be translated directly to a FileDescriptorProto
T8b949e// without any other information (e.g. without reading its imports).
Tff7b72syntax Tff7b72= Ta5d6ff"proto2"Tb4b4b4;
Tff7b72package T7ee787google.protobufTb4b4b4;
Tff7b72option Te6edf3go_package Tff7b72= Ta5d6ff"google.golang.org/protobuf/types/descriptorpb"Tb4b4b4;
Tff7b72option Te6edf3java_package Tff7b72= Ta5d6ff"com.google.protobuf"Tb4b4b4;
Tff7b72option Te6edf3java_outer_classname Tff7b72= Ta5d6ff"DescriptorProtos"Tb4b4b4;
Tff7b72option Te6edf3csharp_namespace Tff7b72= Ta5d6ff"Google.Protobuf.Reflection"Tb4b4b4;
Tff7b72option Te6edf3objc_class_prefix Tff7b72= Ta5d6ff"GPB"Tb4b4b4;
Tff7b72option Te6edf3cc_enable_arenas Tff7b72= Tff7b72trueTb4b4b4;
T8b949e// descriptor.proto must be optimized for speed because reflection-based
T8b949e// algorithms don't work during bootstrapping.
Tff7b72option Te6edf3optimize_for Tff7b72= Te6edf3SPEEDTb4b4b4;
T8b949e// The protocol compiler can output a FileDescriptorSet containing the .proto
T8b949e// files it parses.
Tff7b72message T56d364FileDescriptorSet Tb4b4b4{
Tff7b72repeated Te6edf3FileDescriptorProto Te6edf3file Tff7b72= T79c0ff1Tb4b4b4;
Tb4b4b4}
T8b949e// Describes a complete .proto file.
Tff7b72message T56d364FileDescriptorProto Tb4b4b4{
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4; T8b949e// file name, relative to root of source tree
Tff7b72optional Tffa657string Tff7b72package Tff7b72= T79c0ff2Tb4b4b4; T8b949e// e.g. "foo", "foo.bar", etc.
T8b949e// Names of files imported by this file.
Tff7b72repeated Tffa657string Te6edf3dependency Tff7b72= T79c0ff3Tb4b4b4;
T8b949e// Indexes of the public imported files in the dependency list above.
Tff7b72repeated Tffa657int32 Te6edf3public_dependency Tff7b72= T79c0ff10Tb4b4b4;
T8b949e// Indexes of the weak imported files in the dependency list.
T8b949e// For Google-internal migration only. Do not use.
Tff7b72repeated Tffa657int32 Te6edf3weak_dependency Tff7b72= T79c0ff11Tb4b4b4;
T8b949e// All top-level definitions in this file.
Tff7b72repeated Te6edf3DescriptorProto Te6edf3message_type Tff7b72= T79c0ff4Tb4b4b4;
Tff7b72repeated Te6edf3EnumDescriptorProto Te6edf3enum_type Tff7b72= T79c0ff5Tb4b4b4;
Tff7b72repeated Te6edf3ServiceDescriptorProto Tff7b72service Tff7b72= T79c0ff6Tb4b4b4;
Tff7b72repeated Te6edf3FieldDescriptorProto Te6edf3extension Tff7b72= T79c0ff7Tb4b4b4;
Tff7b72optional Te6edf3FileOptions Te6edf3options Tff7b72= T79c0ff8Tb4b4b4;
T8b949e// This field contains optional information about the original source code.
T8b949e// You may safely remove this entire field without harming runtime
T8b949e// functionality of the descriptors -- the information is needed only by
T8b949e// development tools.
Tff7b72optional Te6edf3SourceCodeInfo Te6edf3source_code_info Tff7b72= T79c0ff9Tb4b4b4;
T8b949e// The syntax of the proto file.
T8b949e// The supported values are "proto2" and "proto3".
Tff7b72optional Tffa657string Tff7b72syntax Tff7b72= T79c0ff12Tb4b4b4;
Tb4b4b4}
T8b949e// Describes a message type.
Tff7b72message T56d364DescriptorProto Tb4b4b4{
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72repeated Te6edf3FieldDescriptorProto Te6edf3field Tff7b72= T79c0ff2Tb4b4b4;
Tff7b72repeated Te6edf3FieldDescriptorProto Te6edf3extension Tff7b72= T79c0ff6Tb4b4b4;
Tff7b72repeated Te6edf3DescriptorProto Te6edf3nested_type Tff7b72= T79c0ff3Tb4b4b4;
Tff7b72repeated Te6edf3EnumDescriptorProto Te6edf3enum_type Tff7b72= T79c0ff4Tb4b4b4;
Tff7b72message T56d364ExtensionRange Tb4b4b4{
Tff7b72optional Tffa657int32 Te6edf3start Tff7b72= T79c0ff1Tb4b4b4; T8b949e// Inclusive.
Tff7b72optional Tffa657int32 Te6edf3end Tff7b72= T79c0ff2Tb4b4b4; T8b949e// Exclusive.
Tff7b72optional Te6edf3ExtensionRangeOptions Te6edf3options Tff7b72= T79c0ff3Tb4b4b4;
Tb4b4b4}
Tff7b72repeated Te6edf3ExtensionRange Te6edf3extension_range Tff7b72= T79c0ff5Tb4b4b4;
Tff7b72repeated Te6edf3OneofDescriptorProto Te6edf3oneof_decl Tff7b72= T79c0ff8Tb4b4b4;
Tff7b72optional Te6edf3MessageOptions Te6edf3options Tff7b72= T79c0ff7Tb4b4b4;
T8b949e// Range of reserved tag numbers. Reserved tag numbers may not be used by
T8b949e// fields or extension ranges in the same message. Reserved ranges may
T8b949e// not overlap.
Tff7b72message T56d364ReservedRange Tb4b4b4{
Tff7b72optional Tffa657int32 Te6edf3start Tff7b72= T79c0ff1Tb4b4b4; T8b949e// Inclusive.
Tff7b72optional Tffa657int32 Te6edf3end Tff7b72= T79c0ff2Tb4b4b4; T8b949e// Exclusive.
Tb4b4b4}
Tff7b72repeated Te6edf3ReservedRange Te6edf3reserved_range Tff7b72= T79c0ff9Tb4b4b4;
T8b949e// Reserved field names, which may not be used by fields in the same message.
T8b949e// A given name may only be reserved once.
Tff7b72repeated Tffa657string Te6edf3reserved_name Tff7b72= T79c0ff10Tb4b4b4;
Tb4b4b4}
Tff7b72message T56d364ExtensionRangeOptions Tb4b4b4{
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tb4b4b4}
T8b949e// Describes a field within a message.
Tff7b72message T56d364FieldDescriptorProto Tb4b4b4{
Tff7b72enum Te6edf3Type Tb4b4b4{
T8b949e// 0 is reserved for errors.
T8b949e// Order is weird for historical reasons.
Te6edf3TYPE_DOUBLE Tff7b72= T79c0ff1Tb4b4b4;
Te6edf3TYPE_FLOAT Tff7b72= T79c0ff2Tb4b4b4;
T8b949e// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
T8b949e// negative values are likely.
Te6edf3TYPE_INT64 Tff7b72= T79c0ff3Tb4b4b4;
Te6edf3TYPE_UINT64 Tff7b72= T79c0ff4Tb4b4b4;
T8b949e// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
T8b949e// negative values are likely.
Te6edf3TYPE_INT32 Tff7b72= T79c0ff5Tb4b4b4;
Te6edf3TYPE_FIXED64 Tff7b72= T79c0ff6Tb4b4b4;
Te6edf3TYPE_FIXED32 Tff7b72= T79c0ff7Tb4b4b4;
Te6edf3TYPE_BOOL Tff7b72= T79c0ff8Tb4b4b4;
Te6edf3TYPE_STRING Tff7b72= T79c0ff9Tb4b4b4;
T8b949e// Tag-delimited aggregate.
T8b949e// Group type is deprecated and not supported in proto3. However, Proto3
T8b949e// implementations should still be able to parse the group wire format and
T8b949e// treat group fields as unknown fields.
Te6edf3TYPE_GROUP Tff7b72= T79c0ff10Tb4b4b4;
Te6edf3TYPE_MESSAGE Tff7b72= T79c0ff11Tb4b4b4; T8b949e// Length-delimited aggregate.
T8b949e// New in version 2.
Te6edf3TYPE_BYTES Tff7b72= T79c0ff12Tb4b4b4;
Te6edf3TYPE_UINT32 Tff7b72= T79c0ff13Tb4b4b4;
Te6edf3TYPE_ENUM Tff7b72= T79c0ff14Tb4b4b4;
Te6edf3TYPE_SFIXED32 Tff7b72= T79c0ff15Tb4b4b4;
Te6edf3TYPE_SFIXED64 Tff7b72= T79c0ff16Tb4b4b4;
Te6edf3TYPE_SINT32 Tff7b72= T79c0ff17Tb4b4b4; T8b949e// Uses ZigZag encoding.
Te6edf3TYPE_SINT64 Tff7b72= T79c0ff18Tb4b4b4; T8b949e// Uses ZigZag encoding.
Tb4b4b4}
Tff7b72enum Te6edf3Label Tb4b4b4{
T8b949e// 0 is reserved for errors
Te6edf3LABEL_OPTIONAL Tff7b72= T79c0ff1Tb4b4b4;
Te6edf3LABEL_REQUIRED Tff7b72= T79c0ff2Tb4b4b4;
Te6edf3LABEL_REPEATED Tff7b72= T79c0ff3Tb4b4b4;
Tb4b4b4}
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72optional Tffa657int32 Te6edf3number Tff7b72= T79c0ff3Tb4b4b4;
Tff7b72optional Te6edf3Label Te6edf3label Tff7b72= T79c0ff4Tb4b4b4;
T8b949e// If type_name is set, this need not be set. If both this and type_name
T8b949e// are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
Tff7b72optional Te6edf3Type Te6edf3type Tff7b72= T79c0ff5Tb4b4b4;
T8b949e// For message and enum types, this is the name of the type. If the name
T8b949e// starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
T8b949e// rules are used to find the type (i.e. first the nested types within this
T8b949e// message are searched, then within the parent, on up to the root
T8b949e// namespace).
Tff7b72optional Tffa657string Te6edf3type_name Tff7b72= T79c0ff6Tb4b4b4;
T8b949e// For extensions, this is the name of the type being extended. It is
T8b949e// resolved in the same manner as type_name.
Tff7b72optional Tffa657string Te6edf3extendee Tff7b72= T79c0ff2Tb4b4b4;
T8b949e// For numeric types, contains the original text representation of the value.
T8b949e// For booleans, "true" or "false".
T8b949e// For strings, contains the default text contents (not escaped in any way).
T8b949e// For bytes, contains the C escaped value. All bytes >= 128 are escaped.
Tff7b72optional Tffa657string Te6edf3default_value Tff7b72= T79c0ff7Tb4b4b4;
T8b949e// If set, gives the index of a oneof in the containing type's oneof_decl
T8b949e// list. This field is a member of that oneof.
Tff7b72optional Tffa657int32 Te6edf3oneof_index Tff7b72= T79c0ff9Tb4b4b4;
T8b949e// JSON name of this field. The value is set by protocol compiler. If the
T8b949e// user has set a "json_name" option on this field, that option's value
T8b949e// will be used. Otherwise, it's deduced from the field's name by converting
T8b949e// it to camelCase.
Tff7b72optional Tffa657string Te6edf3json_name Tff7b72= T79c0ff10Tb4b4b4;
Tff7b72optional Te6edf3FieldOptions Te6edf3options Tff7b72= T79c0ff8Tb4b4b4;
T8b949e// If true, this is a proto3 "optional". When a proto3 field is optional, it
T8b949e// tracks presence regardless of field type.
T8b949e//
T8b949e// When proto3_optional is true, this field must be belong to a oneof to
T8b949e// signal to old proto3 clients that presence is tracked for this field. This
T8b949e// oneof is known as a "synthetic" oneof, and this field must be its sole
T8b949e// member (each proto3 optional field gets its own synthetic oneof). Synthetic
T8b949e// oneofs exist in the descriptor only, and do not generate any API. Synthetic
T8b949e// oneofs must be ordered after all "real" oneofs.
T8b949e//
T8b949e// For message fields, proto3_optional doesn't create any semantic change,
T8b949e// since non-repeated message fields always track presence. However it still
T8b949e// indicates the semantic detail of whether the user wrote "optional" or not.
T8b949e// This can be useful for round-tripping the .proto file. For consistency we
T8b949e// give message fields a synthetic oneof also, even though it is not required
T8b949e// to track presence. This is especially important because the parser can't
T8b949e// tell if a field is a message or an enum, so it must always create a
T8b949e// synthetic oneof.
T8b949e//
T8b949e// Proto2 optional fields do not set this flag, because they already indicate
T8b949e// optional with `LABEL_OPTIONAL`.
Tff7b72optional Tffa657bool Te6edf3proto3_optional Tff7b72= T79c0ff17Tb4b4b4;
Tb4b4b4}
T8b949e// Describes a oneof.
Tff7b72message T56d364OneofDescriptorProto Tb4b4b4{
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72optional Te6edf3OneofOptions Te6edf3options Tff7b72= T79c0ff2Tb4b4b4;
Tb4b4b4}
T8b949e// Describes an enum type.
Tff7b72message T56d364EnumDescriptorProto Tb4b4b4{
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72repeated Te6edf3EnumValueDescriptorProto Te6edf3value Tff7b72= T79c0ff2Tb4b4b4;
Tff7b72optional Te6edf3EnumOptions Te6edf3options Tff7b72= T79c0ff3Tb4b4b4;
T8b949e// Range of reserved numeric values. Reserved values may not be used by
T8b949e// entries in the same enum. Reserved ranges may not overlap.
T8b949e//
T8b949e// Note that this is distinct from DescriptorProto.ReservedRange in that it
T8b949e// is inclusive such that it can appropriately represent the entire int32
T8b949e// domain.
Tff7b72message T56d364EnumReservedRange Tb4b4b4{
Tff7b72optional Tffa657int32 Te6edf3start Tff7b72= T79c0ff1Tb4b4b4; T8b949e// Inclusive.
Tff7b72optional Tffa657int32 Te6edf3end Tff7b72= T79c0ff2Tb4b4b4; T8b949e// Inclusive.
Tb4b4b4}
T8b949e// Range of reserved numeric values. Reserved numeric values may not be used
T8b949e// by enum values in the same enum declaration. Reserved ranges may not
T8b949e// overlap.
Tff7b72repeated Te6edf3EnumReservedRange Te6edf3reserved_range Tff7b72= T79c0ff4Tb4b4b4;
T8b949e// Reserved enum value names, which may not be reused. A given name may only
T8b949e// be reserved once.
Tff7b72repeated Tffa657string Te6edf3reserved_name Tff7b72= T79c0ff5Tb4b4b4;
Tb4b4b4}
T8b949e// Describes a value within an enum.
Tff7b72message T56d364EnumValueDescriptorProto Tb4b4b4{
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72optional Tffa657int32 Te6edf3number Tff7b72= T79c0ff2Tb4b4b4;
Tff7b72optional Te6edf3EnumValueOptions Te6edf3options Tff7b72= T79c0ff3Tb4b4b4;
Tb4b4b4}
T8b949e// Describes a service.
Tff7b72message T56d364ServiceDescriptorProto Tb4b4b4{
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72repeated Te6edf3MethodDescriptorProto Te6edf3method Tff7b72= T79c0ff2Tb4b4b4;
Tff7b72optional Te6edf3ServiceOptions Te6edf3options Tff7b72= T79c0ff3Tb4b4b4;
Tb4b4b4}
T8b949e// Describes a method of a service.
Tff7b72message T56d364MethodDescriptorProto Tb4b4b4{
Tff7b72optional Tffa657string Te6edf3name Tff7b72= T79c0ff1Tb4b4b4;
T8b949e// Input and output type names. These are resolved in the same way as
T8b949e// FieldDescriptorProto.type_name, but must refer to a message type.
Tff7b72optional Tffa657string Te6edf3input_type Tff7b72= T79c0ff2Tb4b4b4;
Tff7b72optional Tffa657string Te6edf3output_type Tff7b72= T79c0ff3Tb4b4b4;
Tff7b72optional Te6edf3MethodOptions Te6edf3options Tff7b72= T79c0ff4Tb4b4b4;
T8b949e// Identifies if client streams multiple client messages
Tff7b72optional Tffa657bool Te6edf3client_streaming Tff7b72= T79c0ff5 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Identifies if server streams multiple server messages
Tff7b72optional Tffa657bool Te6edf3server_streaming Tff7b72= T79c0ff6 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
Tb4b4b4}
T8b949e// ===================================================================
T8b949e// Options
T8b949e// Each of the definitions above may have "options" attached. These are
T8b949e// just annotations which may cause code to be generated slightly differently
T8b949e// or may contain hints for code that manipulates protocol messages.
T8b949e//
T8b949e// Clients may define custom options as extensions of the *Options messages.
T8b949e// These extensions may not yet be known at parsing time, so the parser cannot
T8b949e// store the values in them. Instead it stores them in a field in the *Options
T8b949e// message called uninterpreted_option. This field must have the same name
T8b949e// across all *Options messages. We then use this field to populate the
T8b949e// extensions when we build a descriptor, at which point all protos have been
T8b949e// parsed and so all extensions are known.
T8b949e//
T8b949e// Extension numbers for custom options may be chosen as follows:
T8b949e// * For options which will only be used within a single application or
T8b949e// organization, or for experimental options, use field numbers 50000
T8b949e// through 99999. It is up to you to ensure that you do not use the
T8b949e// same number for multiple options.
T8b949e// * For options which will be published and used publicly by multiple
T8b949e// independent entities, e-mail protobuf-global-extension-registry@google.com
T8b949e// to reserve extension numbers. Simply provide your project name (e.g.
T8b949e// Objective-C plugin) and your project website (if available) -- there's no
T8b949e// need to explain how you intend to use them. Usually you only need one
T8b949e// extension number. You can declare multiple options with only one extension
T8b949e// number by putting them in a sub-message. See the Custom Options section of
T8b949e// the docs for examples:
T8b949e// https://developers.google.com/protocol-buffers/docs/proto#options
T8b949e// If this turns out to be popular, a web service will be set up
T8b949e// to automatically assign option numbers.
Tff7b72message T56d364FileOptions Tb4b4b4{
T8b949e// Sets the Java package where classes generated from this .proto will be
T8b949e// placed. By default, the proto package is used, but this is often
T8b949e// inappropriate because proto packages do not normally start with backwards
T8b949e// domain names.
Tff7b72optional Tffa657string Te6edf3java_package Tff7b72= T79c0ff1Tb4b4b4;
T8b949e// Controls the name of the wrapper Java class generated for the .proto file.
T8b949e// That class will always contain the .proto file's getDescriptor() method as
T8b949e// well as any top-level extensions defined in the .proto file.
T8b949e// If java_multiple_files is disabled, then all the other classes from the
T8b949e// .proto file will be nested inside the single wrapper outer class.
Tff7b72optional Tffa657string Te6edf3java_outer_classname Tff7b72= T79c0ff8Tb4b4b4;
T8b949e// If enabled, then the Java code generator will generate a separate .java
T8b949e// file for each top-level message, enum, and service defined in the .proto
T8b949e// file. Thus, these types will *not* be nested inside the wrapper class
T8b949e// named by java_outer_classname. However, the wrapper class will still be
T8b949e// generated to contain the file's getDescriptor() method as well as any
T8b949e// top-level extensions defined in the file.
Tff7b72optional Tffa657bool Te6edf3java_multiple_files Tff7b72= T79c0ff10 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// This option does nothing.
Tff7b72optional Tffa657bool Te6edf3java_generate_equals_and_hash Tff7b72= T79c0ff20 Tb4b4b4[Te6edf3deprecatedTff7b72=Tff7b72trueTb4b4b4]Tb4b4b4;
T8b949e// If set true, then the Java2 code generator will generate code that
T8b949e// throws an exception whenever an attempt is made to assign a non-UTF-8
T8b949e// byte sequence to a string field.
T8b949e// Message reflection will do the same.
T8b949e// However, an extension field still accepts non-UTF-8 byte sequences.
T8b949e// This option has no effect on when used with the lite runtime.
Tff7b72optional Tffa657bool Te6edf3java_string_check_utf8 Tff7b72= T79c0ff27 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Generated classes can be optimized for speed or code size.
Tff7b72enum Te6edf3OptimizeMode Tb4b4b4{
Te6edf3SPEED Tff7b72= T79c0ff1Tb4b4b4; T8b949e// Generate complete code for parsing, serialization,
T8b949e// etc.
Te6edf3CODE_SIZE Tff7b72= T79c0ff2Tb4b4b4; T8b949e// Use ReflectionOps to implement these methods.
Te6edf3LITE_RUNTIME Tff7b72= T79c0ff3Tb4b4b4; T8b949e// Generate code using MessageLite and the lite runtime.
Tb4b4b4}
Tff7b72optional Te6edf3OptimizeMode Te6edf3optimize_for Tff7b72= T79c0ff9 Tb4b4b4[Tff7b72default Tff7b72= Te6edf3SPEEDTb4b4b4]Tb4b4b4;
T8b949e// Sets the Go package where structs generated from this .proto will be
T8b949e// placed. If omitted, the Go package will be derived from the following:
T8b949e// - The basename of the package import path, if provided.
T8b949e// - Otherwise, the package statement in the .proto file, if present.
T8b949e// - Otherwise, the basename of the .proto file, without extension.
Tff7b72optional Tffa657string Te6edf3go_package Tff7b72= T79c0ff11Tb4b4b4;
T8b949e// Should generic services be generated in each language? "Generic" services
T8b949e// are not specific to any particular RPC system. They are generated by the
T8b949e// main code generators in each language (without additional plugins).
T8b949e// Generic services were the only kind of service generation supported by
T8b949e// early versions of google.protobuf.
T8b949e//
T8b949e// Generic services are now considered deprecated in favor of using plugins
T8b949e// that generate code specific to your particular RPC system. Therefore,
T8b949e// these default to false. Old code which depends on generic services should
T8b949e// explicitly set them to true.
Tff7b72optional Tffa657bool Te6edf3cc_generic_services Tff7b72= T79c0ff16 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
Tff7b72optional Tffa657bool Te6edf3java_generic_services Tff7b72= T79c0ff17 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
Tff7b72optional Tffa657bool Te6edf3py_generic_services Tff7b72= T79c0ff18 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
Tff7b72optional Tffa657bool Te6edf3php_generic_services Tff7b72= T79c0ff42 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Is this file deprecated?
T8b949e// Depending on the target platform, this can emit Deprecated annotations
T8b949e// for everything in the file, or it will be completely ignored; in the very
T8b949e// least, this is a formalization for deprecating files.
Tff7b72optional Tffa657bool Te6edf3deprecated Tff7b72= T79c0ff23 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Enables the use of arenas for the proto messages in this file. This applies
T8b949e// only to generated classes for C++.
Tff7b72optional Tffa657bool Te6edf3cc_enable_arenas Tff7b72= T79c0ff31 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72trueTb4b4b4]Tb4b4b4;
T8b949e// Sets the objective c class prefix which is prepended to all objective c
T8b949e// generated classes from this .proto. There is no default.
Tff7b72optional Tffa657string Te6edf3objc_class_prefix Tff7b72= T79c0ff36Tb4b4b4;
T8b949e// Namespace for generated classes; defaults to the package.
Tff7b72optional Tffa657string Te6edf3csharp_namespace Tff7b72= T79c0ff37Tb4b4b4;
T8b949e// By default Swift generators will take the proto package and CamelCase it
T8b949e// replacing '.' with underscore and use that to prefix the types/symbols
T8b949e// defined. When this options is provided, they will use this value instead
T8b949e// to prefix the types/symbols defined.
Tff7b72optional Tffa657string Te6edf3swift_prefix Tff7b72= T79c0ff39Tb4b4b4;
T8b949e// Sets the php class prefix which is prepended to all php generated classes
T8b949e// from this .proto. Default is empty.
Tff7b72optional Tffa657string Te6edf3php_class_prefix Tff7b72= T79c0ff40Tb4b4b4;
T8b949e// Use this option to change the namespace of php generated classes. Default
T8b949e// is empty. When this option is empty, the package name will be used for
T8b949e// determining the namespace.
Tff7b72optional Tffa657string Te6edf3php_namespace Tff7b72= T79c0ff41Tb4b4b4;
T8b949e// Use this option to change the namespace of php generated metadata classes.
T8b949e// Default is empty. When this option is empty, the proto file name will be
T8b949e// used for determining the namespace.
Tff7b72optional Tffa657string Te6edf3php_metadata_namespace Tff7b72= T79c0ff44Tb4b4b4;
T8b949e// Use this option to change the package of ruby generated classes. Default
T8b949e// is empty. When this option is not set, the package name will be used for
T8b949e// determining the ruby package.
Tff7b72optional Tffa657string Te6edf3ruby_package Tff7b72= T79c0ff45Tb4b4b4;
T8b949e// The parser stores options it doesn't recognize here.
T8b949e// See the documentation for the "Options" section above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message.
T8b949e// See the documentation for the "Options" section above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tff7b72reserved T79c0ff38Tb4b4b4;
Tb4b4b4}
Tff7b72message T56d364MessageOptions Tb4b4b4{
T8b949e// Set true to use the old proto1 MessageSet wire format for extensions.
T8b949e// This is provided for backwards-compatibility with the MessageSet wire
T8b949e// format. You should not use this for any other reason: It's less
T8b949e// efficient, has fewer features, and is more complicated.
T8b949e//
T8b949e// The message must be defined exactly as follows:
T8b949e// message Foo {
T8b949e// option message_set_wire_format = true;
T8b949e// extensions 4 to max;
T8b949e// }
T8b949e// Note that the message cannot have any defined fields; MessageSets only
T8b949e// have extensions.
T8b949e//
T8b949e// All extensions of your type must be singular messages; e.g. they cannot
T8b949e// be int32s, enums, or repeated messages.
T8b949e//
T8b949e// Because this is an option, the above two restrictions are not enforced by
T8b949e// the protocol compiler.
Tff7b72optional Tffa657bool Te6edf3message_set_wire_format Tff7b72= T79c0ff1 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Disables the generation of the standard "descriptor()" accessor, which can
T8b949e// conflict with a field of the same name. This is meant to make migration
T8b949e// from proto1 easier; new code should avoid fields named "descriptor".
Tff7b72optional Tffa657bool Te6edf3no_standard_descriptor_accessor Tff7b72= T79c0ff2 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Is this message deprecated?
T8b949e// Depending on the target platform, this can emit Deprecated annotations
T8b949e// for the message, or it will be completely ignored; in the very least,
T8b949e// this is a formalization for deprecating messages.
Tff7b72optional Tffa657bool Te6edf3deprecated Tff7b72= T79c0ff3 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
Tff7b72reserved T79c0ff4Tb4b4b4, T79c0ff5Tb4b4b4, T79c0ff6Tb4b4b4;
T8b949e// Whether the message is an automatically generated map entry type for the
T8b949e// maps field.
T8b949e//
T8b949e// For maps fields:
T8b949e// map<KeyType, ValueType> map_field = 1;
T8b949e// The parsed descriptor looks like:
T8b949e// message MapFieldEntry {
T8b949e// option map_entry = true;
T8b949e// optional KeyType key = 1;
T8b949e// optional ValueType value = 2;
T8b949e// }
T8b949e// repeated MapFieldEntry map_field = 1;
T8b949e//
T8b949e// Implementations may choose not to generate the map_entry=true message, but
T8b949e// use a native map in the target language to hold the keys and values.
T8b949e// The reflection APIs in such implementations still need to work as
T8b949e// if the field is a repeated message field.
T8b949e//
T8b949e// NOTE: Do not set the option in .proto files. Always use the maps syntax
T8b949e// instead. The option should only be implicitly set by the proto compiler
T8b949e// parser.
Tff7b72optional Tffa657bool Te6edf3map_entry Tff7b72= T79c0ff7Tb4b4b4;
Tff7b72reserved T79c0ff8Tb4b4b4; T8b949e// javalite_serializable
Tff7b72reserved T79c0ff9Tb4b4b4; T8b949e// javanano_as_lite
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tb4b4b4}
Tff7b72message T56d364FieldOptions Tb4b4b4{
T8b949e// The ctype option instructs the C++ code generator to use a different
T8b949e// representation of the field than it normally would. See the specific
T8b949e// options below. This option is not yet implemented in the open source
T8b949e// release -- sorry, we'll try to include it in a future version!
Tff7b72optional Te6edf3CType Tff7b72ctype Tff7b72= T79c0ff1 Tb4b4b4[Tff7b72default Tff7b72= Te6edf3STRINGTb4b4b4]Tb4b4b4;
Tff7b72enum Te6edf3CType Tb4b4b4{
T8b949e// Default mode.
Te6edf3STRING Tff7b72= T79c0ff0Tb4b4b4;
Te6edf3CORD Tff7b72= T79c0ff1Tb4b4b4;
Te6edf3STRING_PIECE Tff7b72= T79c0ff2Tb4b4b4;
Tb4b4b4}
T8b949e// The packed option can be enabled for repeated primitive fields to enable
T8b949e// a more efficient representation on the wire. Rather than repeatedly
T8b949e// writing the tag and type for each element, the entire array is encoded as
T8b949e// a single length-delimited blob. In proto3, only explicit setting it to
T8b949e// false will avoid using packed encoding.
Tff7b72optional Tffa657bool Tff7b72packed Tff7b72= T79c0ff2Tb4b4b4;
T8b949e// The jstype option determines the JavaScript type used for values of the
T8b949e// field. The option is permitted only for 64 bit integral and fixed types
T8b949e// (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
T8b949e// is represented as JavaScript string, which avoids loss of precision that
T8b949e// can happen when a large value is converted to a floating point JavaScript.
T8b949e// Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
T8b949e// use the JavaScript "number" type. The behavior of the default option
T8b949e// JS_NORMAL is implementation dependent.
T8b949e//
T8b949e// This option is an enum to permit additional types to be added, e.g.
T8b949e// goog.math.Integer.
Tff7b72optional Te6edf3JSType Te6edf3jstype Tff7b72= T79c0ff6 Tb4b4b4[Tff7b72default Tff7b72= Te6edf3JS_NORMALTb4b4b4]Tb4b4b4;
Tff7b72enum Te6edf3JSType Tb4b4b4{
T8b949e// Use the default type.
Te6edf3JS_NORMAL Tff7b72= T79c0ff0Tb4b4b4;
T8b949e// Use JavaScript strings.
Te6edf3JS_STRING Tff7b72= T79c0ff1Tb4b4b4;
T8b949e// Use JavaScript numbers.
Te6edf3JS_NUMBER Tff7b72= T79c0ff2Tb4b4b4;
Tb4b4b4}
T8b949e// Should this field be parsed lazily? Lazy applies only to message-type
T8b949e// fields. It means that when the outer message is initially parsed, the
T8b949e// inner message's contents will not be parsed but instead stored in encoded
T8b949e// form. The inner message will actually be parsed when it is first accessed.
T8b949e//
T8b949e// This is only a hint. Implementations are free to choose whether to use
T8b949e// eager or lazy parsing regardless of the value of this option. However,
T8b949e// setting this option true suggests that the protocol author believes that
T8b949e// using lazy parsing on this field is worth the additional bookkeeping
T8b949e// overhead typically needed to implement it.
T8b949e//
T8b949e// This option does not affect the public interface of any generated code;
T8b949e// all method signatures remain the same. Furthermore, thread-safety of the
T8b949e// interface is not affected by this option; const methods remain safe to
T8b949e// call from multiple threads concurrently, while non-const methods continue
T8b949e// to require exclusive access.
T8b949e//
T8b949e//
T8b949e// Note that implementations may choose not to check required fields within
T8b949e// a lazy sub-message. That is, calling IsInitialized() on the outer message
T8b949e// may return true even if the inner message has missing required fields.
T8b949e// This is necessary because otherwise the inner message would have to be
T8b949e// parsed in order to perform the check, defeating the purpose of lazy
T8b949e// parsing. An implementation which chooses not to check required fields
T8b949e// must be consistent about it. That is, for any particular sub-message, the
T8b949e// implementation must either *always* check its required fields, or *never*
T8b949e// check its required fields, regardless of whether or not the message has
T8b949e// been parsed.
T8b949e//
T8b949e// As of 2021, lazy does no correctness checks on the byte stream during
T8b949e// parsing. This may lead to crashes if and when an invalid byte stream is
T8b949e// finally parsed upon access.
T8b949e//
T8b949e// TODO(b/211906113): Enable validation on lazy fields.
Tff7b72optional Tffa657bool Te6edf3lazy Tff7b72= T79c0ff5 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// unverified_lazy does no correctness checks on the byte stream. This should
T8b949e// only be used where lazy with verification is prohibitive for performance
T8b949e// reasons.
Tff7b72optional Tffa657bool Te6edf3unverified_lazy Tff7b72= T79c0ff15 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Is this field deprecated?
T8b949e// Depending on the target platform, this can emit Deprecated annotations
T8b949e// for accessors, or it will be completely ignored; in the very least, this
T8b949e// is a formalization for deprecating fields.
Tff7b72optional Tffa657bool Te6edf3deprecated Tff7b72= T79c0ff3 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// For Google-internal migration only. Do not use.
Tff7b72optional Tffa657bool Te6edf3weak Tff7b72= T79c0ff10 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tff7b72reserved T79c0ff4Tb4b4b4; T8b949e// removed jtype
Tb4b4b4}
Tff7b72message T56d364OneofOptions Tb4b4b4{
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tb4b4b4}
Tff7b72message T56d364EnumOptions Tb4b4b4{
T8b949e// Set this option to true to allow mapping different tag names to the same
T8b949e// value.
Tff7b72optional Tffa657bool Te6edf3allow_alias Tff7b72= T79c0ff2Tb4b4b4;
T8b949e// Is this enum deprecated?
T8b949e// Depending on the target platform, this can emit Deprecated annotations
T8b949e// for the enum, or it will be completely ignored; in the very least, this
T8b949e// is a formalization for deprecating enums.
Tff7b72optional Tffa657bool Te6edf3deprecated Tff7b72= T79c0ff3 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
Tff7b72reserved T79c0ff5Tb4b4b4; T8b949e// javanano_as_lite
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tb4b4b4}
Tff7b72message T56d364EnumValueOptions Tb4b4b4{
T8b949e// Is this enum value deprecated?
T8b949e// Depending on the target platform, this can emit Deprecated annotations
T8b949e// for the enum value, or it will be completely ignored; in the very least,
T8b949e// this is a formalization for deprecating enum values.
Tff7b72optional Tffa657bool Te6edf3deprecated Tff7b72= T79c0ff1 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tb4b4b4}
Tff7b72message T56d364ServiceOptions Tb4b4b4{
T8b949e// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
T8b949e// framework. We apologize for hoarding these numbers to ourselves, but
T8b949e// we were already using them long before we decided to release Protocol
T8b949e// Buffers.
T8b949e// Is this service deprecated?
T8b949e// Depending on the target platform, this can emit Deprecated annotations
T8b949e// for the service, or it will be completely ignored; in the very least,
T8b949e// this is a formalization for deprecating services.
Tff7b72optional Tffa657bool Te6edf3deprecated Tff7b72= T79c0ff33 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tb4b4b4}
Tff7b72message T56d364MethodOptions Tb4b4b4{
T8b949e// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
T8b949e// framework. We apologize for hoarding these numbers to ourselves, but
T8b949e// we were already using them long before we decided to release Protocol
T8b949e// Buffers.
T8b949e// Is this method deprecated?
T8b949e// Depending on the target platform, this can emit Deprecated annotations
T8b949e// for the method, or it will be completely ignored; in the very least,
T8b949e// this is a formalization for deprecating methods.
Tff7b72optional Tffa657bool Te6edf3deprecated Tff7b72= T79c0ff33 Tb4b4b4[Tff7b72default Tff7b72= Tff7b72falseTb4b4b4]Tb4b4b4;
T8b949e// Is this method side-effect-free (or safe in HTTP parlance), or idempotent,
T8b949e// or neither? HTTP based RPC implementation may choose GET verb for safe
T8b949e// methods, and PUT verb for idempotent methods instead of the default POST.
Tff7b72enum Te6edf3IdempotencyLevel Tb4b4b4{
Te6edf3IDEMPOTENCY_UNKNOWN Tff7b72= T79c0ff0Tb4b4b4;
Te6edf3NO_SIDE_EFFECTS Tff7b72= T79c0ff1Tb4b4b4; T8b949e// implies idempotent
Te6edf3IDEMPOTENT Tff7b72= T79c0ff2Tb4b4b4; T8b949e// idempotent, but may have side effects
Tb4b4b4}
Tff7b72optional Te6edf3IdempotencyLevel Te6edf3idempotency_level Tff7b72= T79c0ff34
Tb4b4b4[Tff7b72default Tff7b72= Te6edf3IDEMPOTENCY_UNKNOWNTb4b4b4]Tb4b4b4;
T8b949e// The parser stores options it doesn't recognize here. See above.
Tff7b72repeated Te6edf3UninterpretedOption Te6edf3uninterpreted_option Tff7b72= T79c0ff999Tb4b4b4;
T8b949e// Clients can define custom options in extensions of this message. See above.
Tff7b72extensions T79c0ff1000 Tff7b72to Tff7b72maxTb4b4b4;
Tb4b4b4}
T8b949e// A message representing a option the parser does not recognize. This only
T8b949e// appears in options protos created by the compiler::Parser class.
T8b949e// DescriptorPool resolves these when building Descriptor objects. Therefore,
T8b949e// options protos in descriptor objects (e.g. returned by Descriptor::options(),
T8b949e// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
T8b949e// in them.
Tff7b72message T56d364UninterpretedOption Tb4b4b4{
T8b949e// The name of the uninterpreted option. Each string represents a segment in
T8b949e// a dot-separated name. is_extension is true iff a segment represents an
T8b949e// extension (denoted with parentheses in options specs in .proto files).
T8b949e// E.g.,{ ["foo", false], ["bar.baz", true], ["moo", false] } represents
T8b949e// "foo.(bar.baz).moo".
Tff7b72message T56d364NamePart Tb4b4b4{
Tff7b72required Tffa657string Te6edf3name_part Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72required Tffa657bool Te6edf3is_extension Tff7b72= T79c0ff2Tb4b4b4;
Tb4b4b4}
Tff7b72repeated Te6edf3NamePart Te6edf3name Tff7b72= T79c0ff2Tb4b4b4;
T8b949e// The value of the uninterpreted option, in whatever type the tokenizer
T8b949e// identified it as during parsing. Exactly one of these should be set.
Tff7b72optional Tffa657string Te6edf3identifier_value Tff7b72= T79c0ff3Tb4b4b4;
Tff7b72optional Tffa657uint64 Te6edf3positive_int_value Tff7b72= T79c0ff4Tb4b4b4;
Tff7b72optional Tffa657int64 Te6edf3negative_int_value Tff7b72= T79c0ff5Tb4b4b4;
Tff7b72optional Tffa657double Te6edf3double_value Tff7b72= T79c0ff6Tb4b4b4;
Tff7b72optional Tffa657bytes Te6edf3string_value Tff7b72= T79c0ff7Tb4b4b4;
Tff7b72optional Tffa657string Te6edf3aggregate_value Tff7b72= T79c0ff8Tb4b4b4;
Tb4b4b4}
T8b949e// ===================================================================
T8b949e// Optional source code info
T8b949e// Encapsulates information about the original source file from which a
T8b949e// FileDescriptorProto was generated.
Tff7b72message T56d364SourceCodeInfo Tb4b4b4{
T8b949e// A Location identifies a piece of source code in a .proto file which
T8b949e// corresponds to a particular definition. This information is intended
T8b949e// to be useful to IDEs, code indexers, documentation generators, and similar
T8b949e// tools.
T8b949e//
T8b949e// For example, say we have a file like:
T8b949e// message Foo {
T8b949e// optional string foo = 1;
T8b949e// }
T8b949e// Let's look at just the field definition:
T8b949e// optional string foo = 1;
T8b949e// ^ ^^ ^^ ^ ^^^
T8b949e// a bc de f ghi
T8b949e// We have the following locations:
T8b949e// span path represents
T8b949e// [a,i) [ 4, 0, 2, 0 ] The whole field definition.
T8b949e// [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
T8b949e// [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
T8b949e// [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
T8b949e// [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
T8b949e//
T8b949e// Notes:
T8b949e// - A location may refer to a repeated field itself (i.e. not to any
T8b949e// particular index within it). This is used whenever a set of elements are
T8b949e// logically enclosed in a single code segment. For example, an entire
T8b949e// extend block (possibly containing multiple extension definitions) will
T8b949e// have an outer location whose path refers to the "extensions" repeated
T8b949e// field without an index.
T8b949e// - Multiple locations may have the same path. This happens when a single
T8b949e// logical declaration is spread out across multiple places. The most
T8b949e// obvious example is the "extend" block again -- there may be multiple
T8b949e// extend blocks in the same scope, each of which will have the same path.
T8b949e// - A location's span is not always a subset of its parent's span. For
T8b949e// example, the "extendee" of an extension declaration appears at the
T8b949e// beginning of the "extend" block and is shared by all extensions within
T8b949e// the block.
T8b949e// - Just because a location's span is a subset of some other location's span
T8b949e// does not mean that it is a descendant. For example, a "group" defines
T8b949e// both a type and a field in a single declaration. Thus, the locations
T8b949e// corresponding to the type and field and their components will overlap.
T8b949e// - Code which tries to interpret locations should probably be designed to
T8b949e// ignore those that it doesn't understand, as more types of locations could
T8b949e// be recorded in the future.
Tff7b72repeated Te6edf3Location Te6edf3location Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72message T56d364Location Tb4b4b4{
T8b949e// Identifies which part of the FileDescriptorProto was defined at this
T8b949e// location.
T8b949e//
T8b949e// Each element is a field number or an index. They form a path from
T8b949e// the root FileDescriptorProto to the place where the definition occurs.
T8b949e// For example, this path:
T8b949e// [ 4, 3, 2, 7, 1 ]
T8b949e// refers to:
T8b949e// file.message_type(3) // 4, 3
T8b949e// .field(7) // 2, 7
T8b949e// .name() // 1
T8b949e// This is because FileDescriptorProto.message_type has field number 4:
T8b949e// repeated DescriptorProto message_type = 4;
T8b949e// and DescriptorProto.field has field number 2:
T8b949e// repeated FieldDescriptorProto field = 2;
T8b949e// and FieldDescriptorProto.name has field number 1:
T8b949e// optional string name = 1;
T8b949e//
T8b949e// Thus, the above path gives the location of a field name. If we removed
T8b949e// the last element:
T8b949e// [ 4, 3, 2, 7 ]
T8b949e// this path refers to the whole field declaration (from the beginning
T8b949e// of the label to the terminating semicolon).
Tff7b72repeated Tffa657int32 Te6edf3path Tff7b72= T79c0ff1 Tb4b4b4[Tff7b72packed Tff7b72= Tff7b72trueTb4b4b4]Tb4b4b4;
T8b949e// Always has exactly three or four elements: start line, start column,
T8b949e// end line (optional, otherwise assumed same as start line), end column.
T8b949e// These are packed into a single field for efficiency. Note that line
T8b949e// and column numbers are zero-based -- typically you will want to add
T8b949e// 1 to each before displaying to a user.
Tff7b72repeated Tffa657int32 Te6edf3span Tff7b72= T79c0ff2 Tb4b4b4[Tff7b72packed Tff7b72= Tff7b72trueTb4b4b4]Tb4b4b4;
T8b949e// If this SourceCodeInfo represents a complete declaration, these are any
T8b949e// comments appearing before and after the declaration which appear to be
T8b949e// attached to the declaration.
T8b949e//
T8b949e// A series of line comments appearing on consecutive lines, with no other
T8b949e// tokens appearing on those lines, will be treated as a single comment.
T8b949e//
T8b949e// leading_detached_comments will keep paragraphs of comments that appear
T8b949e// before (but not connected to) the current element. Each paragraph,
T8b949e// separated by empty lines, will be one comment element in the repeated
T8b949e// field.
T8b949e//
T8b949e// Only the comment content is provided; comment markers (e.g. //) are
T8b949e// stripped out. For block comments, leading whitespace and an asterisk
T8b949e// will be stripped from the beginning of each line other than the first.
T8b949e// Newlines are included in the output.
T8b949e//
T8b949e// Examples:
T8b949e//
T8b949e// optional int32 foo = 1; // Comment attached to foo.
T8b949e// // Comment attached to bar.
T8b949e// optional int32 bar = 2;
T8b949e//
T8b949e// optional string baz = 3;
T8b949e// // Comment attached to baz.
T8b949e// // Another line attached to baz.
T8b949e//
T8b949e// // Comment attached to moo.
T8b949e// //
T8b949e// // Another line attached to moo.
T8b949e// optional double moo = 4;
T8b949e//
T8b949e// // Detached comment for corge. This is not leading or trailing comments
T8b949e// // to moo or corge because there are blank lines separating it from
T8b949e// // both.
T8b949e//
T8b949e// // Detached comment for corge paragraph 2.
T8b949e//
T8b949e// optional string corge = 5;
T8b949e// /* Block comment attached
T8b949e// * to corge. Leading asterisks
T8b949e// * will be removed. */
T8b949e// /* Block comment attached to
T8b949e// * grault. */
T8b949e// optional int32 grault = 6;
T8b949e//
T8b949e// // ignored detached comments.
Tff7b72optional Tffa657string Te6edf3leading_comments Tff7b72= T79c0ff3Tb4b4b4;
Tff7b72optional Tffa657string Te6edf3trailing_comments Tff7b72= T79c0ff4Tb4b4b4;
Tff7b72repeated Tffa657string Te6edf3leading_detached_comments Tff7b72= T79c0ff6Tb4b4b4;
Tb4b4b4}
Tb4b4b4}
T8b949e// Describes the relationship between generated code and its original source
T8b949e// file. A GeneratedCodeInfo message is associated with only one generated
T8b949e// source file, but may contain references to different source .proto files.
Tff7b72message T56d364GeneratedCodeInfo Tb4b4b4{
T8b949e// An Annotation connects some span of text in generated code to an element
T8b949e// of its generating .proto file.
Tff7b72repeated Te6edf3Annotation Te6edf3annotation Tff7b72= T79c0ff1Tb4b4b4;
Tff7b72message T56d364Annotation Tb4b4b4{
T8b949e// Identifies the element in the original source .proto file. This field
T8b949e// is formatted the same as SourceCodeInfo.Location.path.
Tff7b72repeated Tffa657int32 Te6edf3path Tff7b72= T79c0ff1 Tb4b4b4[Tff7b72packed Tff7b72= Tff7b72trueTb4b4b4]Tb4b4b4;
T8b949e// Identifies the filesystem path to the original source .proto.
Tff7b72optional Tffa657string Te6edf3source_file Tff7b72= T79c0ff2Tb4b4b4;
T8b949e// Identifies the starting offset in bytes in the generated code
T8b949e// that relates to the identified object.
Tff7b72optional Tffa657int32 Te6edf3begin Tff7b72= T79c0ff3Tb4b4b4;
T8b949e// Identifies the ending offset in bytes in the generated code that
T8b949e// relates to the identified offset. The end offset should be one past
T8b949e// the last relevant byte (so the length of the text = end - begin).
Tff7b72optional Tffa657int32 Te6edf3end Tff7b72= T79c0ff4Tb4b4b4;
Tb4b4b4}
Tb4b4b4}
Served by rngit 1.5.2 - Generated in 0.07s